Skip to content

Add Testing Markdown Documentation for Standalone Detailed Inspection#25

Merged
dustin-cook merged 4 commits into
OpenPBEE:mainfrom
hgp297:testing-documentation
Mar 31, 2026
Merged

Add Testing Markdown Documentation for Standalone Detailed Inspection#25
dustin-cook merged 4 commits into
OpenPBEE:mainfrom
hgp297:testing-documentation

Conversation

@wangz539

Copy link
Copy Markdown
Collaborator

Summary

This PR adds the guide for users who need to validate their own ATC-138 MATLAB vs. Python results using the standalone comparison engine (compare_runs.py) and explains the metrics used in ATC-138.

Contents

  • Describes the validation workflow for MATLAB vs Python outputs
  • Documents the four comparison metrics
  • Includes example results for two representative models (ICSB, HaseltonRCMF_4story)

Motivation

While the current repo includes integration tests, this doc provides more detailed instructions for users who need to validate their own models outside of the testing framework. The metrics we use for the published version are also explained.

@wangz539 wangz539 changed the title Add testing markdown doc for standalone detailed inspection Add Testing Markdown Documentation for Standalone Detailed Inspection Mar 31, 2026

@hgp297 hgp297 left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Fixes #24

Looks good. Recommend one or two line to explain rationale between having both absolute and relative metrics.

wangz539 and others added 3 commits March 30, 2026 19:20
…yproject.toml

- Added available options for the CLI command, including `--seed` and `--force_rebuild`.
- Expanded the input validation section to cover common errors and solutions.
- Included details on overriding default inputs and customizing static tables.
@dustin-cook
dustin-cook merged commit c518538 into OpenPBEE:main Mar 31, 2026
18 checks passed
@hgp297
hgp297 deleted the testing-documentation branch March 31, 2026 18:42
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants